Docs: add and extend docstrings across executorlib - #992
Conversation
Add missing docstrings to ResourceDictValidation, FutureSelector, private helpers in task_scheduler/file/shared.py, and several inputcheck validators. Extend existing one-liners with Args/Returns/Raises sections throughout executor/base.py, task_scheduler/base.py, standalone/serialize.py, and standalone/interactive/communication.py. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
Warning Review limit reached
More reviews will be available in 20 minutes and 14 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (8)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #992 +/- ##
=======================================
Coverage 94.16% 94.16%
=======================================
Files 39 39
Lines 2090 2090
=======================================
Hits 1968 1968
Misses 122 122 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
1 participant
Summary
ResourceDictValidationlisting all fields and their meaningFutureSelectorand its__init__,__getattr__,__setattr__, andresultmethods instandalone/select.py_get_function_name(standalone/serialize.py), the no-opvalidate_resource_dict(task_scheduler/base.py), and the private helpers_get_task_input,_cancel_futures,_shutdown_executorintask_scheduler/file/shared.pystandalone/inputcheck.py(check_max_workers_and_cores,check_hostname_localhost,check_restart_limit,check_pmi_mode,validate_number_of_cores),standalone/validate.py(_get_accepted_keys,validate_resource_dict,validate_resource_dict_with_optional_keys),standalone/interactive/communication.py(interface_connect,interface_receive), andexecutor/base.py+task_scheduler/base.py(max_workersproperty/setter)Test plan
python -c "import ast; ast.parse(open('src/executorlib/...').read())"passes for all modified files (already verified locally)🤖 Generated with Claude Code